docs(cookbook): revamp docker-compose-quickstart against playbook#664
Open
SuhaniNagpal7 wants to merge 1 commit into
Open
docs(cookbook): revamp docker-compose-quickstart against playbook#664SuhaniNagpal7 wants to merge 1 commit into
SuhaniNagpal7 wants to merge 1 commit into
Conversation
What changed - Frontmatter: kebab-case schema with slug, author, products, frameworks, difficulty, tags, og-image, canonical, last-tested-date, structured last-tested-with, code-repo-url, page-type. - Added "What you'll build" section listing the deliverables (21 containers, four secrets, first user, smoke-test trace, ops cheatsheet) before the 10-15 minute image build investment. - Added "Verify your environment" step before "Why self-host" so the first proof moment (Docker version + RAM check) lands in the first 5% of the page instead of 90%. Catches the most common OOM-kill failure before the user invests time. - Trimmed "Why self-host" from 159 to 53 words: two reasons (compliance + localhost speed) and a one-line bridge to the steps. - Mermaid stack diagram simplified from 12 nodes + 4 subgraphs + 11 arrows down to 4 nodes + 3 arrows showing the core write/CDC/read loop (SDK -> apps -> Postgres -[PeerDB CDC]-> ClickHouse -[reads]-> apps). The full 21-container inventory lives in the existing per- layer table inside Step 3. - Em dashes purged across body, tips, and troubleshooting. - Troubleshooting table gained "Verify" column with a verification step per row. - Replaced "Explore further" reference cards with a 4-item technical next-steps ladder (pin image tags, durable storage, TLS reverse proxy, Postgres backups) + one reference link. - Step 5 closes with a real screenshot of the FAGI Tracing dashboard showing a live support_agent trace for the local-stack-smoke-test project (Trace Graph + span detail panel with the User Message, Input, and refund-policy Output captured end-to-end). Depends on - #660 (Mermaid component) for the diagram in "The self-hosted stack" to render. The diagram has been simplified; full functionality requires #660 to merge first.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
title+descriptiononlyslug,date,author,products,frameworks,difficulty,time-to-complete,tags,og-image,canonical,last-tested-date, structuredlast-tested-with,code-repo-url,page-typeVerifysupport_agenttrace (Trace Graph + span detail panel with User Message, Input, and refund-policy Output)Why this is shaped the way it is
docker --version + memory checkis the only honest proof we can put that early.support_agenttrace was sent through the cloud API with the sameproject_name: local-stack-smoke-testso the dashboard view is structurally identical to what a self-hosted user would see atlocalhost:3000.Depends on
<Mermaid>component used by the simplified stack diagram in "The self-hosted stack." Merge docs(cookbook): revamp eval-correction-loop + add Mermaid component #660 first.Test plan
pnpm devand visit/docs/cookbook/self-hosting/docker-compose-quickstart. Confirm:grep -nE "(-|-)" src/pages/docs/cookbook/self-hosting/docker-compose-quickstart.mdxreturns no hits.pnpm astro buildpasses.